Add JSDoc for extras/splat ply-reader/splat-material/splat #5868
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I think I found another bug:
The property |
|
This might be related |
mvaligursky
reviewed
Nov 30, 2023
| */ | ||
|
|
||
| /** | ||
| * @typedef {object} PlyProperty |
There was a problem hiding this comment.
do we even use these types anywhere?
There was a problem hiding this comment.
yep, PlyElement is used once in ply-reader.js and three times in splat-data.js:
class SplatData {
/** @type {import('./ply-reader').PlyElement[]} */
elements;
/** @type {import('./ply-reader').PlyElement} */
vertexElement;
/**
* @param {import('./ply-reader').PlyElement[]} elements - The elements.
* @param {boolean} [performZScale] - Whether to perform z scaling.
*/
constructor(elements, performZScale = true) {
mvaligursky
approved these changes
Dec 11, 2023
There was a problem hiding this comment.
This looks great, I don't see any problems, keen to merge. Any concerns @slimbuck ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also adding
jsconfig.jsand fixing a small issue withfindforUInt8Array's (it would skip a good/last result) because it used<and not<=.Motivation is to have a better IDE experience (static type-checking and Intellisense) and also to have more types in playcanvas-extras that we can validate via RTI (dynamic type-checking for NaN's for example).
I confirm I have read the contributing guidelines and signed the Contributor License Agreement.